<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <title>Description of Configurable properties of Terrier</title>
 <link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="docs.css"> 
  <meta http-equiv="Content-Type"
 content="text/html; charset=iso-8859-1">
</head>
  <body>
<!--!bodystart--> 
 [<a href="hadoop_indexing.html">Previous: Hadoop Map Reduce Indexing with Terrier</a>] [<a href="index.html">Contents</a>] [<a href="terrier_develop.html">Next: Developing with Terrier</a>]
<table width="100%">
   <tbody>
    <tr>
     <td width="82%" valign="bottom">
      <h1>Description of Configurable properties of Terrier</h1>
      </td>
		<!--!bodyremove-->
     <td width="18%"><a href="http://ir.dcs.gla.ac.uk/terrier/"><img
 src="images/terrier-logo-web.jpg" border="0">
      </a></td>
		<!--!/bodyremove-->
   </tr>
 
  </tbody>
</table>
 
<p align="justify">Terrier allows the user to configure many different aspects
of the framework, in order to be adaptable to the specific needs of different
applications. Here, we describe the properties that are used while indexing
or  retrieving. A sample of how to set up the basic properties can be found
in <a href="../etc/terrier.properties.sample">etc/terrier.properties.sample</a>.
This page contains many of the properties in Terrier, broken down by category:
<a href="#general">General</a>, <a href="#indexing">Indexing</a>, <a href="#retrieval">Retrieval</a>,
<a href="#desktop">Desktop Search</a> and <a href="#misc">Miscellaneous</a>.

</p>






<h2><a name="general">General properties</a></h2>
<table border="1" width="100%">
 <tbody>
 <tr>
      <td width="15%">Property</td>
      <td><b>string.use_utf</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>true,false</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>true</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Enables/Disables <a href="configure_indexing.html">UTF support</a> during indexing. 
      </td>
    </tr>
 
  </tbody>
</table>
 
  <table border="1" width="100%">
 <tbody>
 <tr>
      <td width="15%">Property</td>
      <td><b>terrier.setup</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Absolute directory path</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Specifies where Terrier finds the terrier.properties file, which is usually in the etc/ directory. Analogous to terrier.etc property</td>
    </tr>
 
  </tbody>
</table>


<table border="1" width="100%">
 <tbody>
 <tr>
      <td width="15%">Property</td>
      <td><b>terrier.home</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Absolute directory path</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>ApplicationSetup.TERRIER_HOME. Where Terrier is installed.</td>
    </tr>
 
  </tbody>
</table>
  
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>terrier.etc</b></td>
    </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>
   </tr>
 <tr>
      <td>Possible values</td>
      <td>Absolute directory path</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>TERRIER_HOME + "etc/"</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>TERRIER_ETC. Where terrier finds it's terrier.properties file if
-Dterrier.setup is not specified</td>
    </tr>
 
  </tbody>
</table>
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>terrier.share</b></td>
    </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a href="javadoc/uk/ac/gla/terrier/terms/Stopwords.html">uk.ac.gla.terrier.terms.Stopwords</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
      <td>Absolute directory path</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>TERRIER_HOME + "share/"</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>ApplicationSetup.TERRIER_SHARE. Where static distribution files are found, for instance the stopword files.</td>
    </tr>
 
  </tbody>
</table>
  
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>terrier.var</b></td>
    </tr>
 <tr>
      
    </tr>
    <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/applications/desktop/filehandling/WindowsFileOpener.html">uk.ac.gla.terrier.applications.desktop.filehandling.WindowsFileOpener</a>,
       <a href="javadoc/uk/ac/gla/terrier/structures/Index.html">uk.ac.gla.terrier.structures.Index</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
      <td>Absolute directory path</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>TERRIER_HOME + "var/"</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>TERRIER_VAR. Where Terrier puts files that it creates, e.g. indices and results files.</td>
    </tr>
 
  </tbody>
</table>

<h2><a name="indexing">Indexing</a></h2>


 <br>
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>terrier.index.path</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/indexing/SimpleFileCollection.html">uk.ac.gla.terrier.indexing.SimpleFileCollection</a>,
       <a href="javadoc/uk/ac/gla/terrier/indexing/TRECCollection.html">uk.ac.gla.terrier.indexing.TRECCollection</a>
     </td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>fully path of a directory</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>TERRIER_VAR + "index/"</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>TERRIER_INDEX_PATH. The name of the directory in which the data
structures        created by Terrier are stored</td>
   </tr>
 
  </tbody>
</table>
 
 
 
 
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>terrier.index.prefix</b></td>
    </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a href="javadoc/uk/ac/gla/terrier/indexing/Indexer.html">uk.ac.gla.terrier.indexing.Indexer</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
      <td>Filename prefix for all the indices</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>"data"</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>TERRIER_INDEX_PREFIX. Filename prefix for all the indices.</td>
    </tr>
 
  </tbody>
</table>




<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>stopwords.filename</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a href="javadoc/uk/ac/gla/terrier/terms/Stopwords.html">uk.ac.gla.terrier.terms.Stopwords</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>absolute path to file</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>TERRIER_SHARE + "stopword-list.txt"</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>The name of the file which contains a list of stopwords.</td>
   </tr>
 
  </tbody>
</table>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>collection.spec</b></td>
    </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/indexing/SimpleFileCollection.html">uk.ac.gla.terrier.indexing.SimpleFileCollection</a>,
       <a href="javadoc/uk/ac/gla/terrier/indexing/TRECCollection.html">uk.ac.gla.terrier.indexing.TRECCollection</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
      <td>Absolute filename</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>TERRIER_ETC + value of "collection.spec"</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>COLLECTION_SPEC. Where the indexing process should find it's configuration
for the Collection object. This is often a list of files or directories.</td>
    </tr>
 
  </tbody>
</table>



<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>ignore.empty.documents</b></td>
    </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a href="javadoc/uk/ac/gla/terrier/indexing/Indexer.html">uk.ac.gla.terrier.indexing.Indexer
       </a></td>
   </tr>
 <tr>
      <td>Possible values</td>
      <td>true, false</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>false</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>IGNORE_EMPTY_DOCUMENTS. Whether empty documents have an entry in
the document index.</td>
    </tr>
 
  </tbody>
</table>
 

 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>???.process</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/utility/TagSet.html">uk.ac.gla.terrier.utility.TagSet</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma delimited list of tags to process</td>
   </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>For many of the tokenisers, configures which tags should be processed. ??? can be TrecDocTags or TrecQueryTags, to configure the TREC Collection and Query parsers respectively. ??? as FieldTags specifies the field that should be stored in the index.
      </td>
    </tr>
 
  </tbody>
</table>
 
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>???.skip</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/utility/TagSet.html">uk.ac.gla.terrier.utility.TagSet</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma delimited list of tags to not process</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>For many of the tokenisers, configures which tags should be skipped completely. ??? can be TrecDocTags or TrecQueryTags, to configure the
    TREC Collection and Query parsers respectively.</td>
    </tr>
 
  </tbody>
</table>

 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>???.doctag</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/utility/TagSet.html">uk.ac.gla.terrier.utility.TagSet</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Name of tag that marks the start of the document (trec only)</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>For some of the tokenisers, configures which tag which contains
the opening tag (or query ID). ??? can be TrecDocTags or TrecQueryTags, to configure the
    TREC Collection and Query parsers respectively.</td>
    </tr>
 
  </tbody>
</table>
  
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>???.idtag</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/utility/TagSet.html">uk.ac.gla.terrier.utility.TagSet</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Name of tag that contains the unique identifier (trec only)</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>For some of the tokenisers, configures which tag which contains
the document ID (or query ID). ??? can be TrecDocTags or TrecQueryTags, to configure the
    TREC Collection and Query parsers respectively.</td>
    </tr>
 
  </tbody>
</table>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>???.casesensitive</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/utility/TagSet.html">uk.ac.gla.terrier.utility.TagSet</a>
		<a href="javadoc/uk/ac/gla/terrier/indexing/TRECCollection.html">uk.ac.gla.terrier.indexing.TRECCollection</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>true or false</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>true for TrecDocTags, false otherwise</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>For some of the tokenisers, configures if the tag matching is case-sensitive or not. The default is true for TRECCollection (TrecDocTags), and false for FieldTags and TrecQueryTags (TRECFullTokenizer which is used by the TREC query parser (TRECQuery)).</td></tr>

  </tbody>
</table>




 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>block.indexing</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>, 
      <a href="javadoc/uk/ac/gla/terrier/applications/TRECIndexing.html">uk.ac.gla.terrier.applications.TRECIndexing</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>true, false</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>false</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>ApplicationSetup.BLOCK_INDEXING. Sets whether block positions should
be saved during indexing. This is required to do phrasal searches. Client
code should examine this to determine whether to use the BasicIndexer or
the BlockIndexer.</td>
   </tr>
 
  </tbody>
</table>
  
 
 <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>block.size</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a href="javadoc/uk/ac/gla/terrier/indexing/BlockIndexer.html">uk.ac.gla.terrier.indexing.BlockIndexer</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>integer &gt; 0</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>1</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>ApplicationSetup.BLOCK_SIZE. The number of terms contained in the
same block</td>
   </tr>
 
  </tbody>
</table>
 
 
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>max.blocks</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a href="javadoc/uk/ac/gla/terrier/indexing/BlockIndexer.html">uk.ac.gla.terrier.indexing.BlockIndexer</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>integer &gt;= 0</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>100000</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>MAX_BLOCKS. The maximum number of blocks a document may contain.</td>
   </tr>
 
  </tbody>
</table>
 
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>lowercase</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a href="javadoc/uk/ac/gla/terrier/indexing/HTMLDocument.html">uk.ac.gla.terrier.indexing.HTMLDocument</a>,
       <a href="javadoc/uk/ac/gla/terrier/indexing/TRECDocument.html">uk.ac.gla.terrier.indexing.TRECDocument</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/indexing/TRECFullTokenizer.html">uk.ac.gla.terrier.indexing.TRECFullTokenizer</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>true, or false</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>true</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>Whether text is converted to lowercase before parsing</td>
   </tr>
 
  </tbody>
</table>
 
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>indexing.max.tokens</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a href="javadoc/uk/ac/gla/terrier/indexing/Indexer.html">uk.ac.gla.terrier.indexing.Indexer</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>integer &gt;=0</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>0</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>Sets a limit to the maximum number of tokens indexed for a document.
The default value 0 means that there is no limit.</td>
   </tr>
 
  </tbody>
</table>
 

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>indexing.max.docs.per.builder</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a href="javadoc/uk/ac/gla/terrier/indexing/Indexer.html">uk.ac.gla.terrier.indexing.Indexer</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>integer &gt;=0</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>18,000,000</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>Sets a limit to the maximum number of documents in one index during indexing. After this point, 
a new index will be created, and at the end, all the indices will be merged. 
Reasoning: During classical two-pass indexing, memory is constrained by the TermCodes table. If too many different unique terms are indexed, then an OutOfMemoryError will occur. For TREC GOV2 collection, 18 million documents is a good point to start a new index. The special value 0 means that there is no limit. This property also applies for single-pass indexing, although it can be safely set higher.</td>
   </tr>

  </tbody>
</table>
 
 




















<h3>Advanced</h3>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>termpipelines</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/querying/Manager.html">uk.ac.gla.terrier.querying.Manager</a>,
      <a href="javadoc/uk/ac/gla/terrier/indexing/Indexer.html">uk.ac.gla.terrier.indexing.Indexer</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma delimited list of term pipeline entities to pass query terms through. Use blank to denote
		no termpipeline objects</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>Stopwords,PorterStemmer</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Defines which term pipeline entities to pass query terms through.</td>
    </tr>
 
  </tbody>
</table>
 
  
  <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>termcodes.initialcapacity</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/utility/TermCodes.html">uk.ac.gla.terrier.utility.TermCodes</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>integer value &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>3000000</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Specifes the initial size of the hashmap used for the term-&gt;term_id
mapping. Setting this appropriately decreases the likelihood of a hashmap
grow occurring</td>
    </tr>
 
  </tbody>
</table>
  
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>invertedfile.processterms</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/InvertedIndexBuilder.html">uk.ac.gla.terrier.structures.indexing.InvertedIndexBuilder</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/BlockInvertedIndexBuilder.html">uk.ac.gla.terrier.structures.indexing.BlockInvertedIndexBuilder</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Integer value &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>75000</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Defines the number of terms that should be processed at once when
building the inverted index. The InvertedIndexBuilder scans the direct index
looking for each of these term, then writes them to inverted index, then
repeats scan for next bunch of terms. Increasing this speeds up inverted
index building for large collections, but uses more memory. Decrease this
if you encounter OutOfMemory errors while building the inverted index.
<p><B>Deprecated</b>: This option has been deprecated in favour of invertedfile.processpointers
For this property to have any effect, invertedfile.processpointers must be set to 0.</p>
</td>
    </tr>
 
  </tbody>
</table>
  
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>invertedfile.processpointers</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/InvertedIndexBuilder.html">uk.ac.gla.terrier.structures.indexing.InvertedIndexBuilder</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/BlockInvertedIndexBuilder.html">uk.ac.gla.terrier.structures.indexing.BlockInvertedIndexBuilder</a></t
d>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Integer value &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>20000000</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Defines the number of pointers that should be processed at once when
building the inverted index. The InvertedIndexBuilder first works out how many terms
correspond to that many pointers, then scans the direct index
looking for each of these term, then writes them to inverted index, then
repeats scan for next bunch of terms. Increasing this speeds up inverted
index building for large collections, but uses more memory. Decrease this
if you encounter OutOfMemory errors while building the inverted index.
Note that for block indexing, the default is lower: 2,000,000 pointers.
<p>This option supersedes invertedfile.processterms. For the invertedfile.processterms strategy
to be used, set invertedfile.processpointers to 0.
</td>
    </tr>

  </tbody>
</table>

 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>lexicon.builder.templexperdir</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/LexiconBuilder.html">uk.ac.gla.terrier.structures.indexing.LexiconBuilder</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/BlockLexiconBuilder.html">uk.ac.gla.terrier.structures.indexing.BlockLexiconBuilder</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>integer values &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>100</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Number of temporary lexicon files to place in each temporary directory
during lexicon building.</td>
    </tr>
 
  </tbody>
</table>
  

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>lexicon.builder.merge.lex.max</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/LexiconBuilder.html">uk.ac.gla.terrier.structures.indexing.LexiconBuilder</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/BlockLexiconBuilder.html">uk.ac.gla.terrier.structures.indexing.BlockLexiconBuilder</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>integer values &gt; 1</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>16</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>The number of temporary lexicons to merge at once during indexing.
during lexicon building. Bigger is generally faster, but too many open file-handles causes slowness. 16 is a good trade-off. (See also the MERGE_FACTOR in GNU sort source code).</td>
    </tr>

  </tbody>
</table>
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>lexicon.builder.merge.2lex.attime</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/LexiconBuilder.html">uk.ac.gla.terrier.structures.indexing.LexiconBuilder</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/BlockLexiconBuilder.html">uk.ac.gla.terrier.structures.indexing.BlockLexiconBuilder</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>boolean values true or false</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>false</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Forces the temporary lexicon merging to revert to Terrier 1.0.x behaviour of merging lexicons in pairs. <p><b>Deprecated</b> This option will be removed in a future release</b></td>
    </tr>

  </tbody>
</table>
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>indexing.excel.maxfilesize.mb</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/indexing/MSExcelDocument.html">uk.ac.gla.terrier.indexing.MSExcelDocument</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>size of a file in megabytes</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>0.5</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>The maximum file size of an Excel spreadsheet to be parsed.</td>
   </tr>
 
  </tbody>
</table>
  

<table border="1" width="100%">
   <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>indexing.simplefilecollection.extensionsparsers</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/indexing/SimpleFileCollection.html">uk.ac.gla.terrier.indexing.SimpleFileCollection</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>comma delimited list of file extensions and associated parsers to
use        for the corresponding files.</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>txt:FileDocument,text:FileDocument,tex:FileDocument,bib:FileDocument, 
      pdf:PDFDocument,html:HTMLDocument,htm:HTMLDocument,xhtml:HTMLDocument, 
      xml:HTMLDocument,doc:MSWordDocument,ppt:MSPowerpointDocument,xls:MSExcelDocument</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>The parsers to be used for processing files with the specified extensions.</td>
   </tr>
 
  </tbody>
</table>


<table border="1" width="100%">
   <tbody>
    <tr>
     <td width="15%">Property</td>
     <td><b>indexing.simplefilecollection.defaultparser</b></td>
   </tr>
   <tr>
     <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/indexing/SimpleFileCollection.html">uk.ac.gla.terrier.indexing.SimpleFileCollection</a></td>
   </tr>
   <tr>
     <td>Possible values</td>
     <td>fully qualified class name</td>
   </tr>
   <tr>
     <td>Default value</td>
     <td>not specified</td>
   </tr>
   <tr>
     <td>Configures</td>
     <td>The parser to use by default for processing files with unknown extensions</td>
   </tr>
 
  </tbody>
</table>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>trec.blacklist.docids</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/indexing/TRECCollection.html">uk.ac.gla.terrier.indexing.TRECCollection</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>full path to filename</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>not specified</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>The name of a file that contains a black list of document identifiers
       to be ignored during indexing</td>
   </tr>
 
  </tbody>
</table>


<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>trec.collection.class</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/applications/TRECIndexing.html">uk.ac.gla.terrier.applications.TRECIndexing</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>a classname implementing Collection interface</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>TRECCollection</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>The Collection object to be used to parse the collection. This allows test collection similar but not identical
	 to TREC to be parsed using Terrier's TREC tools. New in Terrier 1.1.0 is the ability to chain Collections. The Collection
	specified last is the inner-most one of the chain, the first is the outer-most (i.e. instantiation right-to-left). the first
	collection should have a default constructor (no arguments), while the other collections should take as argument in their
	constructor the inner-collection class. E.g. <tt>trec.collection.class=RemoveSmallDocsCollection,TRECCollection</tt>.
	Instantiation handled by the CollectionFactory class.
       </td>
   </tr>

  </tbody>
</table>
 

 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>merge.temp.number</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Integer values &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>100000</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>MERGE_TEMP_NUMBER. Used in temporary lexicon building by the classical two-pass indexers.</td>
    </tr>
 
  </tbody>
</table>
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>bundle.size</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Integer values &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>2000</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>BUNDLE_SIZE. During indexing, number of documents to be processed
before a new index is created.</td>
    </tr>
 
  </tbody>
</table>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>max.term.length</b></td>
    </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a href="javadoc/uk/ac/gla/terrier/indexing/FileDocument.html">uk.ac.gla.terrier.indexing.FileDocument</a>,
       <a href="javadoc/uk/ac/gla/terrier/indexing/HTMLDocument.html">uk.ac.gla.terrier.indexing.HTMLDocument</a>,
       <a href="javadoc/uk/ac/gla/terrier/indexing/TRECDocument.html">uk.ac.gla.terrier.indexing.TRECDocument</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/indexing/TRECFullTokenizer.html">uk.ac.gla.terrier.indexing.TRECFullTokenizer</a>,
       <a href="javadoc/uk/ac/gla/terrier/structures/Lexicon.html">uk.ac.gla.terrier.structures.Lexicon</a>,
       <a href="javadoc/uk/ac/gla/terrier/structures/BlockLexicon.html">uk.ac.gla.terrier.structures.BlockLexicon</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/structures/BlockLexiconInputStream.html">uk.ac.gla.terrier.structures.BlockLexiconInputStream</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/structures/BlockLexiconOutputStream.html">uk.ac.gla.terrier.structures.BlockLexiconOutputStream</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/structures/LexiconInputStream.html">uk.ac.gla.terrier.structures.LexiconInputStream</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/structures/LexiconOutputStream.html">uk.ac.gla.terrier.structures.LexiconOutputStream</a>
     </td>
   </tr>
 <tr>
      <td>Possible values</td>
      <td>Integer value &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>20</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>MAX_TERM_LENGTH. The size in the lexicon reserved for a string, i.e. the max length of any term in the index.
term.</td>
    </tr>
 
  </tbody>
</table>


  <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>docno.byte.length</b></td>
    </tr>
 <tr>
      <td>Used in</td>
     <td><a href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a href="javadoc/uk/ac/gla/terrier/structures/DocumentIndex.html">uk.ac.gla.terrier.structures.DocumentIndex</a>,
       <a href="javadoc/uk/ac/gla/terrier/structures/DocumentIndexEncoded.html">uk.ac.gla.terrier.structures.DocumentIndexEncoded</a>,
       <a href="javadoc/uk/ac/gla/terrier/structures/DocumentIndexInMemory.html">uk.ac.gla.terrier.structures.DocumentIndexInMemory</a>,
       <a href="javadoc/uk/ac/gla/terrier/structures/DocumentIndexInputStream.html">uk.ac.gla.terrier.structures.DocumentIndexInputStream</a>,
     </td>
   </tr>
 <tr>
      <td>Possible values</td>
      <td>Integer value &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>20</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>DOCNO_BYTE_LENGTH. The size in the document index reserved for the document number - i.e. no DOCNO can be longer than this.
		Set this property to 30 for the TREC Blogs06 collection.</td>
    </tr>
 
  </tbody>
</table>
 
   

 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>merge.prefix</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>part of a filename</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>"MRG_"</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>MERGE_PREFIX. Prefix of temporary lexicon files created during
merging</td>
    </tr>
 
  </tbody>
</table>
  

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>memory.reserved</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/indexing/BasicSinglePassIndexer.html">uk.ac.gla.terrier.indexing.BasicSinglePassIndexer</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>integer &gt; 0, probably around 50 million</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>50000000</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Free memory threshold that forces a run to be committed to disk in the single-pass indexer. Higher values means less chance of OutOfMemoryError occurring, but slower indexing speed as more runs will be generated. </td>
    </tr>

  </tbody>
</table>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>memory.heap.usage</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/indexing/BasicSinglePassIndexer.html">uk.ac.gla.terrier.indexing.BasicSinglePassIndexer</a></td>
    </tr>
 <tr> 
      <td>Possible values</td> 
      <td>positive float, range 0.0f - 1.0f</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>0.70</td>
    </tr> 
 <tr>
      <td>Configures</td>
      <td>amount of max heap allocated to JVM before a run is committed. Smaller values mean more runs and hence slower indexing. Larger values means more risk of OutOfMemoryError occurrences.</td>
    </tr>
    
  </tbody>
</table>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>docs.check</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/indexing/BasicSinglePassIndexer.html">uk.ac.gla.terrier.indexing.BasicSinglePassIndexer</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>positive integer &gt; 0 </td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>20</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td> how often to check the amount of free memory. Lower values gives more protection from OutOfMemoryError.</td>
    </tr>

  </tbody>
</table>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>inverted2direct.processtokens</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/structures/indexing/singlepass/Inverted2DirectIndexBuilder.html">uk.ac.gla.terrier.structures.indexing.singlepass.Inverted2DirectIndexBuilder</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>positive long &gt; 0 </td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>100000000, 10000000 for blocks</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td> total number of tokens to attempt each iteration of building the direct index. Use a lower value if OutOfMemoryError occurs.</td>
    </tr>

  </tbody>
</table>

<h2><a name="retrieval">Retrieval</a></h2> 

<h3>Model</h3>


 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>language.model</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/applications/TRECLMIndexing.html">uk.ac.gla.terrier.applications.TRECLMIndexing</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/applications/TRECLMQuerying.html">uk.ac.gla.terrier.applications.TRECLMQuerying</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Class names of implemented language models from the package uk.ac.gla.terrier.matching.models.languagemodel</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>PonteCroft</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>the language model to be used for indexing and querying the collection.
Querying requires collection to have been indexed for language modelling.</td>
    </tr>
 
  </tbody>
</table>
  


<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>ignore.low.idf.terms</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/matching/Matching.html">uk.ac.gla.terrier.matching.Matching</a>,
      <a href="javadoc/uk/ac/gla/terrier/matching/LMMatching.html">uk.ac.gla.terrier.matching.LMMatching</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>true, false</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>true</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Ignores a term that has a low IDF, ie appears in many documents.
You may wish to turn this off for small or focused collections.</td>
    </tr>
 
  </tbody>
</table>
  
 

<h3>Interactive Retrieval</h3>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>interactive.output.format.length</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/applications/InteractiveQuerying.html">uk.ac.gla.terrier.applications.InteractiveQuerying</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>integer number &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>1000</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>the maximum number of results to be displayed for Interactive querying</td>
    </tr>
 
  </tbody>
</table>
  

<h3>Trec Retrieval</h3>
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>trec.model</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/applications/TRECQuerying.html">uk.ac.gla.terrier.applications.TRECQuerying</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Name of weighting models</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>&lt;empty&gt;</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>The weighting model to use during retrieval. If not set, then TRECQuerying iterates through the models found in the trec.models file.
</td>
    </tr>

  </tbody>
</table>
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>trec.models</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Absolute filename</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>TERRIER_ETC + value of "trec.models"</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>TREC_MODELS. What is the location of the file that contains the list of Weighting models to query
with</td>
    </tr>
 
  </tbody>
</table>
  
  
  <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>trec.results</b></b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
      <a href="javadoc/TrecTerrier.html">TrecTerrier</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Absolute directory path</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>TERRIER_VAR + value of "trec.results""</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>TREC_RESULTS. Where TREC*Querying applications should store their
results files and where evaluation files should be placed.</td>
    </tr>
 
  </tbody>
</table>
  
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>trec.topics.list</b></td>
    </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a>,
       <a href="javadoc/uk/ac/gla/terrier/structures/TRECQuery.html">uk.ac.gla.terrier.structures.TRECQuery</a>
     </td>
   </tr>
 <tr>
      <td>Possible values</td>
      <td>Absolute filename</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>TERRIER_ETC + value of "trec.topics.list"</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>TREC_TOPICS_LIST. Contains file with list of TREC topics (queries)
files to run.</td>
    </tr>
 
  </tbody>
</table>
  
 
  
  
  
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>trec.qrels</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/utility/ApplicationSetup.html">uk.ac.gla.terrier.utility.ApplicationSetup</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Absolute filename</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>TERRIER_ETC + "trec.qrels"</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>TREC_QRELS. Contains file with list of TREC qrel files to evaluate
with</td>
    </tr>
 
  </tbody>
</table>
 



<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>trec.output.format.length</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/applications/TRECQuerying.html">uk.ac.gla.terrier.applications.TRECQuerying</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/applications/TRECQueryingExpansion.html">uk.ac.gla.terrier.applications.TRECQueryingExpansion</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/applications/TRECLMQuerying.html">uk.ac.gla.terrier.applications.TRECLMQuerying</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>integer number &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>1000</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>the maximum number of results to be displayed for TREC querying</td>
    </tr>
 
  </tbody>
</table>
  

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>trec.iteration</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/applications/TRECQuerying.html">uk.ac.gla.terrier.applications.TRECQuerying</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/applications/TRECQueryingExpansion.html">uk.ac.gla.terrier.applications.TRECQueryingExpansion</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/applications/TRECLMQuerying.html">uk.ac.gla.terrier.applications.TRECLMQuerying</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>String</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>Q</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Related to standard format of TREC results</td>
    </tr>
 
  </tbody>
</table>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>trec.matching</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/applications/TRECQuerying.html">uk.ac.gla.terrier.applications.TRECQuerying</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/applications/TRECQueryingExpansion.html">uk.ac.gla.terrier.applications.TRECQueryingExpansion</a>,
    </tr>
 <tr>
      <td>Possible values</td>
      <td>String, Class name in uk.ac.gla.terrier.matching</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>Matching</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>The Matching class to use during querying</td>
    </tr>

  </tbody>
</table>

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>trec.manager</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a
 href="javadoc/uk/ac/gla/terrier/applications/TRECQuerying.html">uk.ac.gla.terrier.applications.TRECQuerying</a>,
      <a
 href="javadoc/uk/ac/gla/terrier/applications/TRECQueryingExpansion.html">uk.ac.gla.terrier.applications.TRECQueryingExpansion</a>,
    </tr>
 <tr>
      <td>Possible values</td>
      <td>String, Class name in uk.ac.gla.terrier.querying</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>Manager</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>The Manager class to use during querying</td>
    </tr>

  </tbody>
</table>
  

<h3>Query Expansion</h3>


<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>parameter.free.expansion</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/matching/models/queryexpansion/QueryExpansionModel.html">uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/structures/ExpansionTerms.html">uk.ac.gla.terrier.structures.ExpansionTerms</a>
     </td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>true or false</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>true</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>Whether we apply parameter-free query expansion or not.</td>
   </tr>
 
  </tbody>
</table>
 
 


<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>rocchio_beta</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/matching/models/queryexpansion/QueryExpansionModel.html">uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/structures/ExpansionTerms.html">uk.ac.gla.terrier.structures.ExpansionTerms</a>
     </td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>float</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>0.4</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>The parameter of Rocchio's automatic query expansion</td>
   </tr>
 
  </tbody>
</table>
 
 <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>expansion.models</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/matching/models/queryexpansion/QueryExpansionModel.html">uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/structures/ExpansionTerms.html">uk.ac.gla.terrier.structures.ExpansionTerms</a>
     </td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>File name,relative File path, absolute File path</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>qemodels</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>The name of the file which contains the query expansion
	 methods used. The corresponding property is 
	  <tt>expansion.models</tt> and the default
	  value is <tt>qemodels</tt>. If a relative path is given, 
	  it is prefixed with TERRIER_ETC.</td>
   </tr>
 
  </tbody>
</table>
 
 
 <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>expansion.documents</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/matching/models/queryexpansion/QueryExpansionModel.html">uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/structures/ExpansionTerms.html">uk.ac.gla.terrier.structures.ExpansionTerms</a>
     </td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>integer</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>3</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>The number of top-ranked documents to be considered in the pseudo relevance set</td>
   </tr>
 
  </tbody>
</table>

 
 <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>expansion.terms</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/matching/models/queryexpansion/QueryExpansionModel.html">uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel</a>,
       <a
 href="javadoc/uk/ac/gla/terrier/structures/ExpansionTerms.html">uk.ac.gla.terrier.structures.ExpansionTerms</a>
     </td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>integer</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>10</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>The number of the highest weighted terms from the pseudo relevance set 
	  to be added to the original query. There can be overlap between the 
	 original query terms and the added terms from the pseudo relevance set</td>
   </tr>
 
  </tbody>
</table>

 <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
	<td><b>expansion.mindocuments</b></td>
  </tr>
 <tr>
      <td>Used in</td>
<td>
<a
 href="javadoc/uk/ac/gla/terrier/structures/ExpansionTerms.html">uk.ac.gla.terrier.structures.ExpansionTerms</a>
     </td>
 <tr>
      <td>Possible values</td>
     <td>integer</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>2</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>
The minimum number of documents a term must exist in
before it can be considered to be informative. Defaults to 2. For more information, see
Giambattista Amati: Information Theoretic Approach to Information Extraction. FQAS 2006: 519-529 <a href="http://dx.doi.org/10.1007/11766254_44">DOI 10.1007/11766254_44</a></td>
  </tr>

  </tbody>
</table>
 
  


 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

<h3>Querying</h3>


<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>match.empty.query</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/matching/Matching.html">uk.ac.gla.terrier.matching.Matching</a>,
      <a href="javadoc/uk/ac/gla/terrier/matching/LMMatching.html">uk.ac.gla.terrier.matching.LMMatching</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>true, false</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>true</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>If true, return all documents for an empty query. Use this if you
have post filter/processes to filter out the documents. E.g. link: site: etc</td>
    </tr>
 
  </tbody>
</table>
  
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>querying.allowed.controls</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/querying/Manager.html">uk.ac.gla.terrier.querying.Manager</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma delimited list of which controls are allowed to be specified
on the query. For use in interactive querying.</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>c, range</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Comma delimited list of which controls are allowed to be specified
on the query. For use in interactive querying. "String:String" in the query
are assumed to be fields unless the first string is an allowed control. An
example value would be: c, range, link, site.</td>
    </tr>
 
  </tbody>
</table>
 
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>querying.default.controls</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/querying/Manager.html">uk.ac.gla.terrier.querying.Manager</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma delimited list of control names and values. Names and values
are separated by colon.</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Sets the defaults control values for the querying process. Controls
are used to control the querying process, and may be used to set matching
models, post filters post processes etc. An example value would be: c:10,site:gla.ac.uk</td>
    </tr>
 
  </tbody>
</table>
 
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>querying.postprocesses.order</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/querying/Manager.html">uk.ac.gla.terrier.querying.Manager</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma delimited list of all allowed post processes.</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Specifies the order in which post processes may be be called, and
those that may be called. This is because post processes often have inter-dependencies.
An example value would be: QueryExpansion,Scope,Site</td>
    </tr>
 
  </tbody>
</table>
  
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>querying.postprocesses.controls</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/querying/Manager.html">uk.ac.gla.terrier.querying.Manager</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma and colon delimited list of control names and post process
names.</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Specifies which controls enable which post processes. An example
value would be: site:Site,qe:QueryExpansion,scope:Scope</td>
    </tr>
 
  </tbody>
</table>

 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>querying.postfilters.order</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/querying/Manager.html">uk.ac.gla.terrier.querying.Manager</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma delimited list of all allowed post filters.</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Specifies the order in which post filters may be be called, and
those that may be called. This is because post filters often have inter-dependencies.
An example value would be: LinkFilter</td>
    </tr>
 
  </tbody>
</table>

 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>querying.postfilters.controls</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/querying/Manager.html">uk.ac.gla.terrier.querying.Manager</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma and colon delimited list of control names and post filter
names.</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Specifies which controls enable which post filters. An example
value would be: link:LinkFilter</td>
    </tr>
 
  </tbody>
</table>

 


<h3>Advanced </h3>


<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>matching.dsms</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/matching/Matching.html">uk.ac.gla.terrier.matching.Matching</a>,
      <a href="javadoc/uk/ac/gla/terrier/matching/LMMatching.html">uk.ac.gla.terrier.matching.LMMatching</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma delimited names of classes in uk/ac/gla/terrier/matching/dsms,
or other fully qualified models</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Specifies the static <a
 href="javadoc/uk/ac/gla/terrier/matching/dsms/DocumentScoreModifier.html">uk.ac.gla.terrier.matching.dsms.DocumentScoreModifier</a>s
that should be applied to all terms of all queries.</td>
    </tr>
 
  </tbody>
</table>

 

<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>matching.tsms</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/matching/Matching.html">uk.ac.gla.terrier.matching.Matching</a>,
      <a href="javadoc/uk/ac/gla/terrier/matching/LMMatching.html">uk.ac.gla.terrier.matching.LMMatching</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>Comma delimited names of classes in uk/ac/gla/terrier/matching/tsms,
or other fully qualified models</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Specifies the static <a
 href="javadoc/uk/ac/gla/terrier/matching/dsms/DocumentScoreModifier.html">uk.ac.gla.terrier.matching.dsms.DocumentScoreModifier</a>s
that should be applied for all queries</td>
    </tr>
 
 
 
  </tbody>
</table>



<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>matching.retrieved_set_size</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/matching/Matching.html">uk.ac.gla.terrier.matching.Matching</a>,
      <a href="javadoc/uk/ac/gla/terrier/matching/LMMatching.html">uk.ac.gla.terrier.matching.LMMatching</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>integer values &gt; 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>1000</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Maximum size of the result set.</td>
    </tr>
 
  </tbody>
</table>

 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>frequency.upper.threshold</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/matching/Matching.html">uk.ac.gla.terrier.matching.Matching</a>,
      <a href="javadoc/uk/ac/gla/terrier/matching/LMMatching.html">uk.ac.gla.terrier.matching.LMMatching</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>integer values &gt;= 0</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>0</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Sets a maximum value for the document frequency of any term in
 a document. (Term spam prevention). 0 means no threshold.</td>
    </tr>
 
  </tbody>
</table>



  <h2><a name="desktop">Desktop Terrier</a></h2>

 <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>desktop.file.associations</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/applications/desktop/filehandling/AssociationFileOpener.html">uk.ac.gla.terrier.applications.desktop.filehandling.AssociationFileOpener</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>absolute path to filename</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>TERRIER_VAR/desktop.fileassoc</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>the name of the file in which we save the file type associations
with applications. If no absolute path is specified it will be presumed by
TERRIER_HOME/var </td>
   </tr>
 
  </tbody>
</table>

 <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>desktop.indexing.singlepass</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/applications/desktop/DesktopTerrier.html">uk.ac.gla.terrier.applications.desktop.DesktopTerrier</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>true, false</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>false</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>Whether single-pass indexing is used by in the Desktop Terrier.</td>
   </tr>

  </tbody>
</table
  
 
 <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>desktop.directories.spec</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/applications/desktop/DesktopTerrier.html">uk.ac.gla.terrier.applications.desktop.DesktopTerrier</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>absolute path to filename</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>TERRIER_VAR/desktop.spec</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>the name of the file that holds a list of directories that are to be indexed
     by the Desktop Terrier application</td>
   </tr>
 
  </tbody>
</table>
  
 
 <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>desktop.directories.filelist</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/applications/desktop/DesktopTerrier.html">uk.ac.gla.terrier.applications.desktop.DesktopTerrier</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>absolute path to filename</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>TERRIER_VAR\index\data.filelist</td>
   </tr>
 <tr>
      <td>Configures</td>
     <td>the name of the file in which we list all files that have been indexed</td>
   </tr>
 
  </tbody>
</table>
 
 


  
 
 
 
 <h2><a name="misc">Miscellaneous</a></h2>
 
 
 
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>field.modifiers</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/utility/FieldScore.html">uk.ac.gla.terrier.utility.FieldScore</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>List of double values, comma separated</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>not specified</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>Boosts the score assigned to these terms by the given amount when
it occurs in the field of the same place</td>
    </tr>
 
  </tbody>
</table>
 
 

 
 <table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
      <td><b>termcodes.garbagecollect</b></td>
    </tr>
 <tr>
      <td>Used in</td>
      <td><a href="javadoc/uk/ac/gla/terrier/utility/TermCodes.html">uk.ac.gla.terrier.utility.TermCodes</a></td>
    </tr>
 <tr>
      <td>Possible values</td>
      <td>true, false</td>
    </tr>
 <tr>
      <td>Default value</td>
      <td>true</td>
    </tr>
 <tr>
      <td>Configures</td>
      <td>If true, forces a full Java garbage collection to reclaim memory
once the direct index creation has finished, as the hashmap is then no longer
required.</td>
    </tr>
 
  </tbody>
</table>
 
 
  
<table border="1" width="100%">
 <tbody>
    <tr>
      <td width="15%">Property</td>
     <td><b>trec.collection.pointers</b></td>
   </tr>
 <tr>
      <td>Used in</td>
     <td><a
 href="javadoc/uk/ac/gla/terrier/indexing/TRECCollection.html">uk.ac.gla.terrier.indexing.TRECCollection</a></td>
   </tr>
 <tr>
      <td>Possible values</td>
     <td>full path to filename</td>
   </tr>
 <tr>
      <td>Default value</td>
     <td>TERRIER_INDEX_PATH + "docpointers.col"</td>
   </tr>
      <td>Configures</td>
     <td>The name of a file that saves pointers for each file to the original
text in the collection files.</td>
   </tr>
 
  </tbody>
</table>
<! EOL trec.encoding trecquery.ignore.desc.narr.name.tokens xml.doctag xml.idtag
xml.terms max.number.retrieved>
 
<p></p>
[<a href="hadoop_indexing.html">Previous: Hadoop Map Reduce Indexing with Terrier</a>] [<a href="index.html">Contents</a>] [<a href="terrier_develop.html">Next: Developing with Terrier</a>]

<!--!bodyend-->
<hr> <small> Webpage: <a href="http://ir.dcs.gla.ac.uk/terrier">http://ir.dcs.gla.ac.uk/terrier</a><br>
 Contact: <a href="mailto:terrier@dcs.gla.ac.uk">terrier@dcs.gla.ac.uk</a><br>
 <a href="http://www.dcs.gla.ac.uk/">Department of Computing Science</a><br>
  Copyright (C) 2004-2008 <a href="http://www.gla.ac.uk/">University of Glasgow</a>
</body>
</html>
